gridpack::state_estimation::SEBus Class Reference

#include <se_components.hpp>

Inheritance diagram for gridpack::state_estimation::SEBus:

Collaboration diagram for gridpack::state_estimation::SEBus:

Public Member Functions
	SEBus (void)
	~SEBus (void)
bool	matrixDiagSize (int isize, int jsize) const
bool	matrixDiagValues (ComplexType *values)
bool	vectorSize (int *isize) const
bool	vectorValues (ComplexType *values)
void	setValues (gridpack::ComplexType *values)
int	vectorNumElements () const
void	vectorSetElementIndex (int ielem, int idx)
void	vectorGetElementIndices (int *idx)
void	vectorGetElementValues (ComplexType values, int idx)
void	vectorSetElementValues (ComplexType *values)
int	getXCBufSize (void)
void	setXCBuf (void *buf)
void	setYBus (void)
gridpack::ComplexType	getYBus (void)
void	load (const boost::shared_ptr< gridpack::component::DataCollection > &data)
void	setMode (int mode)
double	getVoltage (void)
ComplexType	getComplexVoltage (void)
double	getPhase (void)
bool	isPV (void)
bool	isIsolated (void) const
bool	serialWrite (char string, const int bufsize, const char signal=NULL)
void	addMeasurement (Measurement measurement)
void	sortMeasurements (void)
int	matrixNumRows () const
int	matrixNumCols () const
void	matrixSetRowIndex (int irow, int idx)
void	matrixSetColIndex (int icol, int idx)
int	matrixGetRowIndex (int idx)
int	matrixGetColIndex (int idx)
int	matrixNumValues () const
void	matrixGetValues (ComplexType values, int rows, int *cols)
void	configureSE (void)
void	saveData (boost::shared_ptr< gridpack::component::DataCollection > data)
void	getShuntGsBs (double gs, double bs)

Constructor & Destructor Documentation

gridpack::state_estimation::SEBus::SEBus ( void )

Simple constructor

gridpack::state_estimation::SEBus::~SEBus ( void )

Simple destructor

Member Function Documentation

void gridpack::state_estimation::SEBus::addMeasurement ( Measurement measurement )

Add a measurement to the bus

Parameters:

measurement

a measurement struct that will be used to assign internal paramters

void gridpack::state_estimation::SEBus::configureSE ( void )

Configure buses with state estimation parameters. These can be used in other methods

ComplexType gridpack::state_estimation::SEBus::getComplexVoltage ( void )

Return the complex voltage on this bus

Returns:: the complex voltage

double gridpack::state_estimation::SEBus::getPhase ( void )

Return the value of the phase angle on this bus

Returns:: : phase angle

void gridpack::state_estimation::SEBus::getShuntGsBs	(	double *	gs,
		double *	bs
	)

Get shunt_gs and shunt_bs

double gridpack::state_estimation::SEBus::getVoltage ( void )

Return the value of the voltage magnitude on this bus

Returns:: voltage magnitude

int gridpack::state_estimation::SEBus::getXCBufSize ( void ) [virtual]

Return the size of the buffer used in data exchanges on the network. For this problem, the voltage magnitude and phase angle need to be exchanged

Returns:: size of buffer

Reimplemented from gridpack::component::BaseComponent.

gridpack::ComplexType gridpack::state_estimation::SEBus::getYBus ( void )

Get values of YBus matrix. These can then be used in subsequent calculations

Reimplemented from gridpack::ymatrix::YMBus.

bool gridpack::state_estimation::SEBus::isIsolated ( void ) const

Return whether or not a bus is isolated

Returns:: true if bus is isolated

Reimplemented from gridpack::ymatrix::YMBus.

bool gridpack::state_estimation::SEBus::isPV ( void )

Return whether or not the bus is a PV bus (V held fixed in powerflow equations)

Returns:: true if bus is PV bus

void gridpack::state_estimation::SEBus::load ( const boost::shared_ptr< gridpack::component::DataCollection > & data ) [virtual]

Load values stored in DataCollection object into SEBus object. The DataCollection object will have been filled when the network was created from an external configuration file

Parameters:

data,:

DataCollection object contain parameters relevant to this bus that were read in when network was initialized

Reimplemented from gridpack::ymatrix::YMBus.

bool gridpack::state_estimation::SEBus::matrixDiagSize	(	int *	isize,
		int *	jsize
	)			const `[virtual]`

Return size of matrix block on the diagonal contributed by component

Parameters:

isize,jsize,:

number of rows and columns of matrix block

Returns:: : false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBus.

bool gridpack::state_estimation::SEBus::matrixDiagValues ( ComplexType * values ) [virtual]

Return the values of for a diagonal matrix block. The values are returned in row-major order

Parameters:

values,:

pointer to matrix block values

Returns:: : false if network component does not contribute matrix element

Reimplemented from gridpack::ymatrix::YMBus.

int gridpack::state_estimation::SEBus::matrixGetColIndex ( int idx ) [virtual]

Get the column index corresponding to the columns contributed by this component

Parameters:

icol

index of column contributed by this component (e.g. if component contributes 3 columns then icol is between 0 and 2)

Returns:: matrix index of column icol

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBus::matrixGetRowIndex ( int idx ) [virtual]

Get the row index corresponding to the rows contributed by this component

Parameters:

irow

index of row contributed by this component (e.g. if component contributes 3 rows then irow is between 0 and 2)

Returns:: matrix index of row irow

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBus::matrixGetValues	(	ComplexType *	values,
		int *	rows,
		int *	cols
	)			`[virtual]`

Return values from a matrix block

Parameters:

	values,:	pointer to matrix block values
	rows,:	pointer to matrix block rows
	cols,:	pointer to matrix block cols

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBus::matrixNumCols ( ) const [virtual]

Return number of columns in matrix from component

Returns:: number of columnsows from component

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBus::matrixNumRows ( ) const [virtual]

Return number of rows in matrix from component

Returns:: number of rows from component

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBus::matrixNumValues ( ) const [virtual]

Return the number of matrix values contributed by this component

Returns:: number of matrix values

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBus::matrixSetColIndex	(	int	icol,
		int	idx
	)			`[virtual]`

Set column indices corresponding to the columns contributed by this component

Parameters:

	icol	index of column contributed by this component (e.g. if component contributes 3 columns then icol is between 0 and 2)
	idx	matrix index of column icol

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBus::matrixSetRowIndex	(	int	irow,
		int	idx
	)			`[virtual]`

Set row indices corresponding to the rows contributed by this component

Parameters:

	irow	index of row contributed by this component (e.g. if component contributes 3 rows then irow is between 0 and 2)
	idx	matrix index of row irow

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBus::saveData ( boost::shared_ptr< gridpack::component::DataCollection > data ) [virtual]

Save state variables inside the component to a DataCollection object. This can be used as a way of moving data in a way that is useful for creating output or for copying state data from one network to another.

Parameters:

data

data collection object into which new values are inserted

Reimplemented from gridpack::component::BaseComponent.

bool gridpack::state_estimation::SEBus::serialWrite	(	char *	string,
		const int	bufsize,
		const char *	signal = `NULL`
	)			`[virtual]`

Write output from buses to standard out

Parameters:

	string	(output) string with information to be printed out
	bufsize	size of string buffer in bytes
	signal	an optional character string to signal to this routine what about kind of information to write

Returns:: true if bus is contributing string to output, false otherwise

Reimplemented from gridpack::component::BaseComponent.

void gridpack::state_estimation::SEBus::setMode ( int mode ) [virtual]

Set the mode to control what matrices and vectors are built when using the mapper

Parameters:

mode,:

enumerated constant for different modes

Reimplemented from gridpack::ymatrix::YMBus.

void gridpack::state_estimation::SEBus::setValues ( gridpack::ComplexType * values ) [virtual]

Set the internal values of the voltage magnitude and phase angle. Need this function to push values from vectors back onto buses

Parameters:

values

array containing voltage magnitude and angle

Reimplemented from gridpack::component::MatVecInterface.

void gridpack::state_estimation::SEBus::setXCBuf ( void * buf ) [virtual]

Assign pointers for voltage magnitude and phase angle

Reimplemented from gridpack::component::BaseComponent.

void gridpack::state_estimation::SEBus::setYBus ( void )

Set values of YBus matrix. These can then be used in subsequent calculations

Reimplemented from gridpack::ymatrix::YMBus.

void gridpack::state_estimation::SEBus::sortMeasurements ( void )

Sort measurements so that they are in a consistent order

void gridpack::state_estimation::SEBus::vectorGetElementIndices ( int * idx ) [virtual]

Get list of element indices from component

Parameters:

idx

list of indices that component maps onto

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBus::vectorGetElementValues	(	ComplexType *	values,
		int *	idx
	)			`[virtual]`

Get a list of vector values contributed by this component and their indices

Parameters:

	values	list of vector element values
	idx	indices for the vector elements

Reimplemented from gridpack::component::GenMatVecInterface.

int gridpack::state_estimation::SEBus::vectorNumElements ( ) const [virtual]

Return number of elements in vector coming from component

Returns:: number of elements contributed from component

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBus::vectorSetElementIndex	(	int	ielem,
		int	idx
	)			`[virtual]`

Set indices corresponding to the elements contributed by this component

Parameters:

	ielem	index of element contributed by this component (e.g. if component contributes 3 elements then ielem is between 0 and 2)
	idx	vector index of element ielem

Reimplemented from gridpack::component::GenMatVecInterface.

void gridpack::state_estimation::SEBus::vectorSetElementValues ( ComplexType * values ) [virtual]

Transfer vector values to component

Parameters:

values

list of vector element values

Reimplemented from gridpack::component::GenMatVecInterface.

bool gridpack::state_estimation::SEBus::vectorSize ( int * isize ) const [virtual]

Return size of vector block contributed by component

Parameters:

isize,:

number of vector elements